/*
 * (C) 2009, Elephant Seven Hamburg Gmbh, 
 * Author: Detlev Wiese
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 
 * use this file except in compliance with the License. You may obtain a copy 
 * of the License at
 *  
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.se and its accompanying notice file is
 * included with the distribution. 
 */ 
package com.e7.streams;

/**
 * <P>This interface should be used to define functions with 
 * boolean return values. </P>
 * <P>{@code Predicate}s are used by {@code LimitedStream}- and 
 * {@code FilteredStream}-instances, these streams apply their 
 * predicate to all their elements.</P> 
 * @param <E> The element type to apply the predicate
 * @see LimitedStream
 * @see FilteredStream
 */
public interface Predicate<E> {
	/**
	 * The receiver will return <code>true</code> for all objects which should 
	 * <b>not</b> be dropped when filtering.
	 * @param object The object for which to apply the predicate
	 */
	public boolean value(E object) ;
}
